This feature release adds a new RTK Query upsertQueryEntries util to batch-upsert cache entries more efficiently, passes through additional values for use in prepareHeaders, and exports additional TS types around query options and selectors.

Changelog

upsertQueryEntries

RTK Query already had an upsertQueryData thunk that would upsert a single cache entry. However, some users wanted to upsert many cache entries (potentially hundreds or thousands), and found that upsertQueryData had poor performance in those cases. This is because upsertQueryData runs the full async request handling sequence, including dispatching both pending and fulfilled actions, each of which run the main reducer and update store subscribers. That means there's 2N store / UI updates per item, so upserting hundreds of items becomes extremely perf-intensive.

RTK Query now includes an api.util.upsertQueryEntries action that is meant to handle the batched upsert use case more efficiently. It's a single synchronous action that accepts an array of many {endpointName, arg, value} entries to upsert. This results in a single store update, making this vastly better for performance vs many individual upsertQueryData calls.

We see this as having two main use cases. The first is prefilling the cache with data retrieved from storage on app startup (and it's worth noting that upsertQueryEntries can accept entries for many different endpoints as part of the same array).

The second is to act as a "pseudo-normalization" tool. RTK Query is not a "normalized" cache. However, there are times when you may want to prefill other cache entries with the contents of another endpoint, such as taking the results of a getPosts list endpoint response and prefilling the individual getPost(id) endpoint cache entries, so that components that reference an individual item endpoint already have that data available.

Currently, you can implement the "pseudo-normalization" approach by dispatching upsertQueryEntries in an endpoint lifecycle, like this:

    <span class="pl-c">// Pre-fill the individual post entries with the results</span>
    <span class="pl-c">// from the list endpoint query</span>
    <span class="pl-en">dispatch</span><span class="pl-kos">(</span>
      <span class="pl-s1">api</span><span class="pl-kos">.</span><span class="pl-c1">util</span><span class="pl-kos">.</span><span class="pl-en">upsertQueryEntries</span><span class="pl-kos">(</span>
        <span class="pl-s1">posts</span><span class="pl-kos">.</span><span class="pl-en">map</span><span class="pl-kos">(</span><span class="pl-kos">(</span><span class="pl-s1">post</span><span class="pl-kos">)</span> <span class="pl-c1">=&gt;</span> <span class="pl-kos">(</span><span class="pl-kos">{</span>
          <span class="pl-c1">endpointName</span>: <span class="pl-s">'getPost'</span><span class="pl-kos">,</span>
          <span class="pl-c1">arg</span>: <span class="pl-kos">{</span> <span class="pl-c1">id</span>: <span class="pl-s1">post</span><span class="pl-kos">.</span><span class="pl-c1">id</span> <span class="pl-kos">}</span><span class="pl-kos">,</span>
          <span class="pl-c1">value</span>: <span class="pl-s1">post</span><span class="pl-kos">,</span>
        <span class="pl-kos">}</span><span class="pl-kos">)</span><span class="pl-kos">)</span><span class="pl-kos">,</span>
      <span class="pl-kos">)</span><span class="pl-kos">,</span>
    <span class="pl-kos">)</span>
  <span class="pl-kos">}</span><span class="pl-kos">,</span>
<span class="pl-kos">}</span><span class="pl-kos">)</span><span class="pl-kos">,</span>
<span class="pl-c1">getPost</span>: <span class="pl-s1">build</span><span class="pl-kos">.</span><span class="pl-en">query</span><span class="pl-kos">&lt;</span><span class="pl-smi">Post</span><span class="pl-kos">,</span> <span class="pl-smi">Pick</span><span class="pl-kos">&lt;</span><span class="pl-smi">Post</span><span class="pl-kos">,</span> <span class="pl-s">'id'</span><span class="pl-kos">&gt;</span><span class="pl-kos">&gt;</span><span class="pl-kos">(</span><span class="pl-kos">{</span>
  <span class="pl-en">query</span>: <span class="pl-kos">(</span><span class="pl-s1">post</span><span class="pl-kos">)</span> <span class="pl-c1">=&gt;</span> <span class="pl-s">`post/<span class="pl-s1"><span class="pl-kos">${</span><span class="pl-s1">post</span><span class="pl-kos">.</span><span class="pl-c1">id</span><span class="pl-kos">}</span></span>`</span><span class="pl-kos">,</span>
<span class="pl-kos">}</span><span class="pl-kos">)</span><span class="pl-kos">,</span>

Down the road we may add a new option to query endpoints that would let you provide the mapping function and have it automatically update the corresponding entries.

For additional comparisons between upsertQueryData and upsertQueryEntries, see the upsertQueryEntries API reference.

prepareHeaders Options

The prepareHeaders callback for fetchBaseQuery now receives two additional values in the api argument:

• arg: the URL string or FetchArgs object that was passed in to fetchBaseQuery for this endpoint
• extraOptions: any extra options that were provided to the base query

Additional TS Types

We've added a TypedQueryStateSelector type that can be used to pre-type selectors for use with selectFromResult:

We've also exported several additional TS types around base queries and tag definitions.

What's Changed

• Fix serializeQueryArgs type by @ Reedgern in #4658
• Add the TypedQueryStateSelector helper type by @ aryaemami59 in #4656
• Pass query args to prepareHeaders function by @ kyletsang in #4638
• Implement a util function to batch-upsert cache entries by @ markerikson in #4561
• fetchBaseQuery: expose extraOptions to prepareHeaders by @ phryneas in #4291

Full Changelog: v2.2.8...v2.3.0

This bugfix release fixes a long-standing issue with RTK Query lazy query triggers returning stale data in some cases, fixes an error handling issue in RTK Query, and exports additional TS types.

Changelog

Lazy Query Trigger Handling

We'd had a couple long-standing issues reporting that const result = await someLazyQueryTrigger() sometimes returned stale data, especially if a mutation had just invalidated that query's tag.

We finally got a good repro of this issue and identified it as a mis-written call inside of the middleware that skipped past the necessary handling to activate the correct query status tracking in that scenario. This should now be fixed.

Other Changes

Timeout handling in RTKQ endpoints should now correctly throw a timeout-related error instead of an AbortError.

Base queries now have access to the current queryCacheKey value so it can be used in deciding query logic.

We've exported several more TS types related to query options, as some users have been depending on those even though they previously weren't part of the public API.

What's Changed

• Export QueryExtraOptions and MutationExtraOptions by @ aryaemami59 in #4556
• Fix mangleErrors not preserving different error types by @ aryaemami59 in #4586
• Add the TypedUseQueryStateOptions helper type by @ aryaemami59 in #4604
• feat(baseQuery): expose queryCacheKey in baseQuery by @ HaakonSvane in #4636
• Fix AbortError being triggered incorrectly on createApi endpoint timeout by @ andrejpavlovic in #4628
• type: export QueryReturnValue by @ hornta in #4640
• call initiate to refetch queries from middleware by @ phryneas in #4651

Full Changelog: v2.2.7...v2.2.8